ugp.org.SerialX

Class Serializer

java.lang.Object

ugp.org.SerialX.Serializer

public class Serializer
extends java.lang.Object

Serializer is powerful utility class that allows you to serialize any object in Java using universal protocol system. This system is generating code similar to JSON called SerialX but unlike JSON, SerialX is based on determinate order of arguments. Also works with regular Java Base64 serialization.

Since:

1.0.0

Author:

PETO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Serializer.ProtocolRegistry ProtocolRegistry, place to register protocols!

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.DecimalFormat	decimalFormatter Decimal formatter to format decimal numbers (double, float) with during serialization! Default DecimalFormat will round decimal numbers to 3 decimal places (format pattern #.###)! Set this on null and decimal numbers will not be formated! Do this when you need accuracy!
static boolean	generateComments Set this on true and program will generate comments and report!
static java.util.Map<java.lang.String,java.lang.Object>	globalVariables Map with global variables, accessible for any serialized content (key is variable name, value is vale).
static Serializer.ProtocolRegistry	PROTOCOL_REGISTRY This is serialization protocol registry.
static boolean	useProtocolIfCan Set this on true to force program to use SerializationProtocol also on java.io.Serializable objects.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	Code(java.lang.String code)
static java.lang.String	Comment(java.lang.String comment)
static java.lang.String	LoadFileToString(java.io.File f)
static java.util.List<java.lang.Object>	LoadFrom(java.io.File f)
static java.util.List<java.lang.Object>	LoadFromString(java.lang.String str)
static java.util.Map<java.lang.String,java.lang.Object>	LoadVariablesFrom(java.io.File f)
static java.util.Map<java.lang.String,java.lang.Object>	LoadVariablesFromString(java.lang.String str)
static java.lang.String	SerializeClassic(java.io.Serializable obj)
static void	SerializeTo(boolean append, java.io.File f, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Object... objs)
static void	SerializeTo(boolean append, java.io.File f, java.lang.Object... objs)
static void	SerializeTo(java.io.File f, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Object... objs)
static void	SerializeTo(java.io.File f, java.lang.Object... objs)
static java.lang.String	SerializeToString(java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Object... objs)
static java.lang.String	SerializeToString(java.lang.Object... objs)
static java.lang.StringBuilder	SerializeToString(java.lang.StringBuilder source, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Object... objs)
static java.lang.StringBuilder	SerializeToString(java.lang.StringBuilder source, java.lang.Object... objs)
static java.lang.String[]	splitValues(java.lang.String s) This function supposed to not be called by user.
static java.lang.Object	UnserializeClassis(java.lang.String objStr)
static <T> java.lang.String	Var(java.lang.String name, T value)
static <T> java.lang.String	Var(java.lang.String name, T value, boolean isValue)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROTOCOL_REGISTRY

public static final Serializer.ProtocolRegistry PROTOCOL_REGISTRY

This is serialization protocol registry. Do not add there two protocols applicable for exactly same classes! Also I recommend to register protocols in generic order of object that are they applicable for! In other words If some object Foo has child classes, protocol of these classes should be registered after each other. Defaultly there is protocol for serializing java.util.List and java.lang.String!

Since:

1.0.0

useProtocolIfCan

public static boolean useProtocolIfCan

Set this on true to force program to use SerializationProtocol also on java.io.Serializable objects. Doing this also might take less memory space then using classic java.io.Serializable. In some cases, java Serialization can be more effective than protocols sometimes not! You should try which gives you the best result, then you can also deactivate certain protocols that are less effective than Java serialization. For example for long strings, classic Java serialization is better than protocol.

Since:

1.0.0

generateComments

public static boolean generateComments

Set this on true and program will generate comments and report!

Since:

1.0.5

decimalFormatter

public static java.text.DecimalFormat decimalFormatter

Decimal formatter to format decimal numbers (double, float) with during serialization! Default DecimalFormat will round decimal numbers to 3 decimal places (format pattern #.###)! Set this on null and decimal numbers will not be formated! Do this when you need accuracy!

globalVariables

public static java.util.Map<java.lang.String,java.lang.Object> globalVariables

Map with global variables, accessible for any serialized content (key is variable name, value is vale).

Since:

1.5.0

Method Detail

Var

public static <T> java.lang.String Var(java.lang.String name,
                                       T value)

Parameters:

name - | Name of variable.

value - | Value of variable.

Returns:

Variable in SerialX form to serialize as [name] = [value].

Since:

1.5.0

Var

public static <T> java.lang.String Var(java.lang.String name,
                                       T value,
                                       boolean isValue)

Parameters:

name - | Name of variable.

value - | Value of variable.

isValue - | True if variables value supposed to by visible also during value loading.

Returns:

Variable in SerialX form to serialize as [name] = [value].

Since:

1.5.0

Comment

public static java.lang.String Comment(java.lang.String comment)

Parameters:

comment - | The comment...

Returns:

Comment in SerialX form.

Since:

1.5.0

Code

public static java.lang.String Code(java.lang.String code)

Parameters:

code - | Code to convert in to SerialX code form.

Returns:

"${" + code + "}"

Since:

1.5.0

SerializeTo

public static void SerializeTo(java.io.File f,
                               java.lang.Object... objs)

Parameters:

f - | File to write in. This must be a text file (recommended extension .srlx).

objs - | Objects to serialize using SerialX.

Since:

1.0.0

SerializeTo

public static void SerializeTo(boolean append,
                               java.io.File f,
                               java.lang.Object... objs)

Parameters:

append - | When true, the new objects will be appended to files content (same objects will be also appended if there are some)!

f - | File to write in. This must be a text file (recommended extension .srlx).

objs - | Objects to serialize using SerialX.

Since:

1.1.0

SerializeToString

public static java.lang.String SerializeToString(java.lang.Object... objs)

Parameters:

objs - | Objects to serialize using SerialX.

Returns:

String with objects serialized in SerialX code.

Since:

1.0.0

SerializeToString

public static java.lang.StringBuilder SerializeToString(java.lang.StringBuilder source,
                                                        java.lang.Object... objs)

Parameters:

source - | Source StringBuilder to serialize objects into!

objs - | Objects to serialize using SerialX.

Returns:

Source StringBuilder with objects serialized in SerialX code.

Since:

1.1.0

SerializeTo

public static void SerializeTo(java.io.File f,
                               java.util.Map<java.lang.String,java.lang.Object> variables,
                               java.lang.Object... objs)

Parameters:

f - | File to write in. This must be a text file (recommended extension .srlx).

variables - | Map with variables to serialize. Keys are names of variables and values are values.

objs - | Objects to serialize using SerialX.

Since:

1.1.5

SerializeTo

public static void SerializeTo(boolean append,
                               java.io.File f,
                               java.util.Map<java.lang.String,java.lang.Object> variables,
                               java.lang.Object... objs)

Parameters:

append - | When true, the new objects will be appended to files content (same objects will be also appended if there are some)!

f - | File to write in. This must be a text file (recommended extension .srlx).

variables - | Map with variables to serialize. Keys are names of variables and values are values.

objs - | Objects to serialize using SerialX.

Since:

1.1.5

SerializeToString

public static java.lang.String SerializeToString(java.util.Map<java.lang.String,java.lang.Object> variables,
                                                 java.lang.Object... objs)

Parameters:

variables - | Map with variables to serialize. Keys are names of variables and values are values.

objs - | Objects to serialize using SerialX.

Returns:

String with variables and objects serialized in SerialX code.

Since:

1.1.5

SerializeToString

public static java.lang.StringBuilder SerializeToString(java.lang.StringBuilder source,
                                                        java.util.Map<java.lang.String,java.lang.Object> variables,
                                                        java.lang.Object... objs)

Parameters:

source - | Source StringBuilder to serialize variables and objects into!

variables - | Map with variables to serialize. Keys are names of variables and values are values.

objs - | Objects to serialize using SerialX.

Returns:

Source StringBuilder with variables and objects serialized in SerialX code.

Since:

1.1.5

SerializeClassic

public static java.lang.String SerializeClassic(java.io.Serializable obj)
                                         throws java.io.IOException

Parameters:

obj - | Object to serialize using classic Java serialization. Note: Slash will be replaced by back slash and Base64 padding with dash due to prevent conflict with SerialX syntax!

Returns:

String with serialized object.

Throws:

java.io.IOException - - if an I/O error occurs while writing stream header

Since:

1.0.0

See Also:

java.lang.Base64

LoadFileToString

public static java.lang.String LoadFileToString(java.io.File f)

Parameters:

f - | Source file.

Returns:

All lines from source file as string.

Since:

1.1.5

LoadFrom

public static java.util.List<java.lang.Object> LoadFrom(java.io.File f)

Parameters:

f - | Text file with serialized objects using SerialX.

Returns:

Unserialized objects or empty ArrayList if file is empty. You can use negative indexes to get objects from back of this array since 1.1.0 (-1 = last element)!

Since:

1.0.0

LoadFromString

public static java.util.List<java.lang.Object> LoadFromString(java.lang.String str)

Parameters:

str - | SerialX string with serialized objects.

Returns:

Unserialized objects or empty ArrayList if string is empty. You can use negative indexes to get objects from back of this array since 1.1.0 (-1 = last element)!

Since:

1.0.0

LoadVariablesFrom

public static java.util.Map<java.lang.String,java.lang.Object> LoadVariablesFrom(java.io.File f)

Parameters:

f - | Text file with serialized variables and objects using SerialX.

Returns:

Map with variables or empty LinkedHashMap if source file contains no variables. Keys represents names of variables and values are values. Global variables will be excluded if their value remain same.

Since:

1.1.5

LoadVariablesFromString

public static java.util.Map<java.lang.String,java.lang.Object> LoadVariablesFromString(java.lang.String str)

Parameters:

str - | SerialX string with serialized variables and objects.

Returns:

Map with variables or empty LinkedHashMap if source string contains no variables. Keys represents names of variables and values are values. Global variables will be excluded if their value remain same.

Since:

1.1.5

UnserializeClassis

public static java.lang.Object UnserializeClassis(java.lang.String objStr)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

Parameters:

objStr - | String to unserialize by classic Java serialization. Note: Backslashes will be replaced by regular slashes and dashes with Base64 padding due to compatibility with SerialX syntax.

Returns:

Unsrialized object.

Throws:

java.io.IOException - - if an I/O error occurs while reading stream header

java.lang.ClassNotFoundException - - Class of a serialized object cannot be found.

Since:

1.0.0

See Also:

Base64

splitValues

public static java.lang.String[] splitValues(java.lang.String s)

This function supposed to not be called by user.

Parameters:

s - | String to split and check some syntax.

Returns:

Spited string.

Since:

1.0.0